<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>BOSS Afterburner: TerminalIO.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">BOSS Afterburner
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('TerminalIO_8h_source.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">TerminalIO.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="TerminalIO_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="preprocessor">#ifndef BOSS_Afterburner_Globals_Functions_TermionalIO_H</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="preprocessor">#define BOSS_Afterburner_Globals_Functions_TermionalIO_H</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;</div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="preprocessor">#include &quot;TString.h&quot;</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="preprocessor">#include &lt;unordered_map&gt;</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;</div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceBOSS__Afterburner.html">BOSS_Afterburner</a></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;{</div><div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="namespaceBOSS__Afterburner_1_1TerminalIO.html">   15</a></span>&#160;  <span class="keyword">namespace </span>TerminalIO</div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;  {</div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="namespaceBOSS__Afterburner_1_1TerminalIO.html#a5b35019e4f74baaa75cd1f5de2a97fb7">CheckMainArguments</a>(<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span>* argv[], <span class="keywordtype">int</span> required = 1);</div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="namespaceBOSS__Afterburner_1_1TerminalIO.html#ac906d4a5d8c31d1130e7b06e8f8a8b12">ColourPrint</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> code, <span class="keyword">const</span> TString&amp; message, <span class="keyword">const</span> TString&amp; quantifier = <span class="stringliteral">&quot;&quot;</span>);</div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="namespaceBOSS__Afterburner_1_1TerminalIO.html#ac66d0f2f2e2bf85ca6a7fdefd6abe1cc">PrintFatalError</a>(<span class="keyword">const</span> TString&amp; message);</div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="namespaceBOSS__Afterburner_1_1TerminalIO.html#ab261c20087541fece30f2e830650b9ed">PrintSuccess</a>(<span class="keyword">const</span> TString&amp; message);</div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="namespaceBOSS__Afterburner_1_1TerminalIO.html#a8751ac933668364ed8a9194561a2d649">PrintWarning</a>(<span class="keyword">const</span> TString&amp; message);</div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="namespaceBOSS__Afterburner_1_1TerminalIO.html#a3cf768f515ced7b0f68b80b0d5ce0371">IsEmptyPtr</a>(<span class="keywordtype">void</span>* ptr);</div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;    <span class="keyword">template</span> &lt;<span class="keyword">class</span> TYPE&gt;</div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;    <span class="keyword">inline</span> TYPE&amp; <a class="code" href="namespaceBOSS__Afterburner_1_1TerminalIO.html#ab8e3a82e28214764ccca58fcc53d98c4">GetFromMap</a>(std::unordered_map&lt;std::string, TYPE&gt;&amp; map, <span class="keyword">const</span> std::string&amp; key,</div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;                            <span class="keyword">const</span> std::string&amp; mapName = <span class="stringliteral">&quot;&quot;</span>);</div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;    <span class="keyword">template</span> &lt;<span class="keyword">class</span> TYPE&gt;</div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;    <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="namespaceBOSS__Afterburner_1_1TerminalIO.html#a010977dcd85834775f52dfa3195cf0db">MapHasKey</a>(std::unordered_map&lt;std::string, TYPE&gt;&amp; map, <span class="keyword">const</span> std::string&amp; key);</div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;  } <span class="comment">// namespace TerminalIO</span></div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="comment"></span>} <span class="comment">// namespace BOSS_Afterburner</span></div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;</div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">class</span> TYPE&gt;</div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="namespaceBOSS__Afterburner_1_1TerminalIO.html#ab8e3a82e28214764ccca58fcc53d98c4">   34</a></span>&#160;<span class="keyword">inline</span> TYPE&amp; <a class="code" href="namespaceBOSS__Afterburner_1_1TerminalIO.html#ab8e3a82e28214764ccca58fcc53d98c4">BOSS_Afterburner::TerminalIO::GetFromMap</a>(std::unordered_map&lt;std::string, TYPE&gt;&amp; map,</div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;                                                      <span class="keyword">const</span> std::string&amp;                     key,</div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;                                                      <span class="keyword">const</span> std::string&amp; mapName)</div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;{</div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;  <span class="comment">// try</span></div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;  <span class="comment">// {</span></div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;    <span class="keywordflow">return</span> map.at(key);</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;  <span class="comment">// }</span></div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;  <span class="comment">// catch(std::exception)</span></div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;  <span class="comment">// {</span></div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;  <span class="comment">//   std::string message = Form(&quot;Could not load key \&quot;%s\&quot;&quot;, key.c_str());</span></div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;  <span class="comment">//   if(!mapName.size()) message += Form(&quot; from map \&quot;%s\&quot;&quot;, mapName.c_str());</span></div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;  <span class="comment">//   message += Form(&quot;\n   ---&gt;&gt; check file %s&quot;, __BASE_FILE__);</span></div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;  <span class="comment">//   message += Form(&quot;\n   ---&gt;&gt; check line %s:%d&quot;, __FILE__, __LINE__);</span></div><div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;  <span class="comment">//   PrintFatalError(message);</span></div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;  <span class="comment">// }</span></div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;}</div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;</div><div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">class</span> TYPE&gt;</div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="namespaceBOSS__Afterburner_1_1TerminalIO.html#a010977dcd85834775f52dfa3195cf0db">   55</a></span>&#160;<span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="namespaceBOSS__Afterburner_1_1TerminalIO.html#a010977dcd85834775f52dfa3195cf0db">BOSS_Afterburner::TerminalIO::MapHasKey</a>(std::unordered_map&lt;std::string, TYPE&gt;&amp; map,</div><div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;                                                    <span class="keyword">const</span> std::string&amp;                     key)</div><div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;{</div><div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;  <span class="keywordflow">return</span> map.find(key) != map.end();</div><div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;}</div><div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;</div><div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="namespaceBOSS__Afterburner_1_1TerminalIO_html_a3cf768f515ced7b0f68b80b0d5ce0371"><div class="ttname"><a href="namespaceBOSS__Afterburner_1_1TerminalIO.html#a3cf768f515ced7b0f68b80b0d5ce0371">BOSS_Afterburner::TerminalIO::IsEmptyPtr</a></div><div class="ttdeci">bool IsEmptyPtr(void *ptr)</div><div class="ttdoc">Auxiliary function that you can used in other functions to check if a pointer that you fed it is a nu...</div><div class="ttdef"><b>Definition:</b> <a href="TerminalIO_8cxx_source.html#l00040">TerminalIO.cxx:40</a></div></div>
<div class="ttc" id="namespaceBOSS__Afterburner_1_1TerminalIO_html_a8751ac933668364ed8a9194561a2d649"><div class="ttname"><a href="namespaceBOSS__Afterburner_1_1TerminalIO.html#a8751ac933668364ed8a9194561a2d649">BOSS_Afterburner::TerminalIO::PrintWarning</a></div><div class="ttdeci">void PrintWarning(const TString &amp;message)</div><div class="ttdoc">Print a warning message in yellow. </div><div class="ttdef"><b>Definition:</b> <a href="TerminalIO_8cxx_source.html#l00034">TerminalIO.cxx:34</a></div></div>
<div class="ttc" id="namespaceBOSS__Afterburner_1_1TerminalIO_html_ac906d4a5d8c31d1130e7b06e8f8a8b12"><div class="ttname"><a href="namespaceBOSS__Afterburner_1_1TerminalIO.html#ac906d4a5d8c31d1130e7b06e8f8a8b12">BOSS_Afterburner::TerminalIO::ColourPrint</a></div><div class="ttdeci">void ColourPrint(const char code, const TString &amp;message, const TString &amp;quantifier=&quot;&quot;)</div><div class="ttdoc">Print a message in a certain colour. </div><div class="ttdef"><b>Definition:</b> <a href="TerminalIO_8cxx_source.html#l00006">TerminalIO.cxx:6</a></div></div>
<div class="ttc" id="namespaceBOSS__Afterburner_1_1TerminalIO_html_ac66d0f2f2e2bf85ca6a7fdefd6abe1cc"><div class="ttname"><a href="namespaceBOSS__Afterburner_1_1TerminalIO.html#ac66d0f2f2e2bf85ca6a7fdefd6abe1cc">BOSS_Afterburner::TerminalIO::PrintFatalError</a></div><div class="ttdeci">void PrintFatalError(const TString &amp;message)</div><div class="ttdoc">Print a fatal error message (that is, one that terminates) in red. </div><div class="ttdef"><b>Definition:</b> <a href="TerminalIO_8cxx_source.html#l00021">TerminalIO.cxx:21</a></div></div>
<div class="ttc" id="namespaceBOSS__Afterburner_1_1TerminalIO_html_a010977dcd85834775f52dfa3195cf0db"><div class="ttname"><a href="namespaceBOSS__Afterburner_1_1TerminalIO.html#a010977dcd85834775f52dfa3195cf0db">BOSS_Afterburner::TerminalIO::MapHasKey</a></div><div class="ttdeci">bool MapHasKey(std::unordered_map&lt; std::string, TYPE &gt; &amp;map, const std::string &amp;key)</div><div class="ttdoc">Returns true if map has a certain key, and returns false if not`. </div><div class="ttdef"><b>Definition:</b> <a href="TerminalIO_8h_source.html#l00055">TerminalIO.h:55</a></div></div>
<div class="ttc" id="namespaceBOSS__Afterburner_html"><div class="ttname"><a href="namespaceBOSS__Afterburner.html">BOSS_Afterburner</a></div><div class="ttdoc">Header with a namespace Settings that contains all settings for the analysis framework. </div><div class="ttdef"><b>Definition:</b> <a href="Draw_8h_source.html#l00017">Draw.h:17</a></div></div>
<div class="ttc" id="namespaceBOSS__Afterburner_1_1TerminalIO_html_ab8e3a82e28214764ccca58fcc53d98c4"><div class="ttname"><a href="namespaceBOSS__Afterburner_1_1TerminalIO.html#ab8e3a82e28214764ccca58fcc53d98c4">BOSS_Afterburner::TerminalIO::GetFromMap</a></div><div class="ttdeci">TYPE &amp; GetFromMap(std::unordered_map&lt; std::string, TYPE &gt; &amp;map, const std::string &amp;key, const std::string &amp;mapName=&quot;&quot;)</div><div class="ttdoc">Construction to try and catch an exception that comes from map::at. </div><div class="ttdef"><b>Definition:</b> <a href="TerminalIO_8h_source.html#l00034">TerminalIO.h:34</a></div></div>
<div class="ttc" id="namespaceBOSS__Afterburner_1_1TerminalIO_html_ab261c20087541fece30f2e830650b9ed"><div class="ttname"><a href="namespaceBOSS__Afterburner_1_1TerminalIO.html#ab261c20087541fece30f2e830650b9ed">BOSS_Afterburner::TerminalIO::PrintSuccess</a></div><div class="ttdeci">void PrintSuccess(const TString &amp;message)</div><div class="ttdoc">Print a success message in green. </div><div class="ttdef"><b>Definition:</b> <a href="TerminalIO_8cxx_source.html#l00028">TerminalIO.cxx:28</a></div></div>
<div class="ttc" id="namespaceBOSS__Afterburner_1_1TerminalIO_html_a5b35019e4f74baaa75cd1f5de2a97fb7"><div class="ttname"><a href="namespaceBOSS__Afterburner_1_1TerminalIO.html#a5b35019e4f74baaa75cd1f5de2a97fb7">BOSS_Afterburner::TerminalIO::CheckMainArguments</a></div><div class="ttdeci">void CheckMainArguments(int argc, char *argv[], int required=1)</div><div class="ttdef"><b>Definition:</b> <a href="TerminalIO_8cxx_source.html#l00013">TerminalIO.cxx:13</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_bfccd401955b95cf8c75461437045ac0.html">inc</a></li><li class="navelem"><a class="el" href="dir_26ef9ee339c5cc4db7c63c78ce40bc13.html">Functions</a></li><li class="navelem"><a class="el" href="TerminalIO_8h.html">TerminalIO.h</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>
